/*
 * Copyright (c) 2012, Fredrik Yttergren
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name LucidBot nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fredrik Yttergren BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package api.tools.files;

import javax.annotation.ParametersAreNonnullByDefault;
import java.io.File;
import java.nio.file.Path;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * A class for matching file names
 */
@ParametersAreNonnullByDefault
public class FileMatcher {
    private final String match;
    private final MatchType type;

    /**
     * Creates a FileMatcher that matches file endings
     *
     * @param match the file ending to match
     * @return a new FileMatcher
     */
    public static FileMatcher getFileEndingMatcher(final String match) {
        return new FileMatcher(checkNotNull(match), MatchType.FILE_ENDING);
    }

    /**
     * Creates a FileMatcher that matches file names
     *
     * @param match the file name to match
     * @return a new FileMatcher
     */
    public static FileMatcher getFileNameMatcher(final String match) {
        return new FileMatcher(checkNotNull(match), MatchType.FILE_NAME);
    }

    private FileMatcher(final String match, final MatchType type) {
        this.match = match;
        this.type = type;
    }

    /**
     * Checks if the specified Path matches this FileMatcher
     *
     * @param file the Path of the file to match against
     * @return true if the Path points to a file and that file matches this matcher, false if it's a directory or doesn't match
     */
    public boolean matches(final Path file) {
        File asFile = file.toFile();
        if (asFile.isDirectory()) return false;
        switch (type) {
            case FILE_ENDING:
                return asFile.getName().endsWith(match);
            case FILE_NAME:
                return asFile.getName().equals(match);
        }
        return false;
    }

    public enum MatchType {
        FILE_ENDING, FILE_NAME
    }
}
